<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XMP Toolkit SDK: TXMPFiles&lt; tStringObj &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xmp_tagline_small.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XMP Toolkit SDK
   &#160;<span id="projectnumber">6.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classTXMPFiles.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classTXMPFiles-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TXMPFiles&lt; tStringObj &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>API for access to the main (document-level) metadata in a file.  
 <a href="classTXMPFiles.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="TXMPFiles_8hpp_source.html">TXMPFiles.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and destructor</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The default constructor initializes an object that is associated with no file. The alternate constructors call <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>. </p>
</div></td></tr>
<tr class="memitem:a14f01e38454178578fd25fff6024fd54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a14f01e38454178578fd25fff6024fd54">TXMPFiles</a> ()</td></tr>
<tr class="memdesc:a14f01e38454178578fd25fff6024fd54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor initializes an object that is associated with no file.  <a href="classTXMPFiles.html#a14f01e38454178578fd25fff6024fd54">More...</a><br /></td></tr>
<tr class="separator:a14f01e38454178578fd25fff6024fd54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5eaa92724cc82d933a32eff9c4636739"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a5eaa92724cc82d933a32eff9c4636739">~TXMPFiles</a> ()  throw ()</td></tr>
<tr class="memdesc:a5eaa92724cc82d933a32eff9c4636739"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor; typical virtual destructor.  <a href="classTXMPFiles.html#a5eaa92724cc82d933a32eff9c4636739">More...</a><br /></td></tr>
<tr class="separator:a5eaa92724cc82d933a32eff9c4636739"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36abe01988d4ca3939138e871c7b75e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a36abe01988d4ca3939138e871c7b75e7">TXMPFiles</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> openFlags=0)</td></tr>
<tr class="memdesc:a36abe01988d4ca3939138e871c7b75e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alternate constructor associates the new <code>XMPFiles</code> object with a specific file.  <a href="classTXMPFiles.html#a36abe01988d4ca3939138e871c7b75e7">More...</a><br /></td></tr>
<tr class="separator:a36abe01988d4ca3939138e871c7b75e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af540b3ea689a6d7381dca4f52132a4ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#af540b3ea689a6d7381dca4f52132a4ac">TXMPFiles</a> (const tStringObj &amp;filePath, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> openFlags=0)</td></tr>
<tr class="memdesc:af540b3ea689a6d7381dca4f52132a4ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alternate constructor associates the new <code>XMPFiles</code> object with a specific file, using a string object.  <a href="classTXMPFiles.html#af540b3ea689a6d7381dca4f52132a4ac">More...</a><br /></td></tr>
<tr class="separator:af540b3ea689a6d7381dca4f52132a4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf343fb6771b482ca72d467233a6f920"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#acf343fb6771b482ca72d467233a6f920">TXMPFiles</a> (const <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt; &amp;original)</td></tr>
<tr class="memdesc:acf343fb6771b482ca72d467233a6f920"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="classTXMPFiles.html#acf343fb6771b482ca72d467233a6f920">More...</a><br /></td></tr>
<tr class="separator:acf343fb6771b482ca72d467233a6f920"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f1483fcc92860460d3772216dfaef81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a3f1483fcc92860460d3772216dfaef81">operator=</a> (const <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt; &amp;rhs)</td></tr>
<tr class="memdesc:a3f1483fcc92860460d3772216dfaef81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="classTXMPFiles.html#a3f1483fcc92860460d3772216dfaef81">More...</a><br /></td></tr>
<tr class="separator:a3f1483fcc92860460d3772216dfaef81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad986c7b2e2d82eaef6cf6a33e9d09b65"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#ad986c7b2e2d82eaef6cf6a33e9d09b65">TXMPFiles</a> (<a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a> xmpFilesObj)</td></tr>
<tr class="memdesc:ad986c7b2e2d82eaef6cf6a33e9d09b65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reconstructs a <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object from an internal reference.  <a href="classTXMPFiles.html#ad986c7b2e2d82eaef6cf6a33e9d09b65">More...</a><br /></td></tr>
<tr class="separator:ad986c7b2e2d82eaef6cf6a33e9d09b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a311fc36fdf7270fe05b1c531cdbbd009"><td class="memItemLeft" align="right" valign="top"><a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a311fc36fdf7270fe05b1c531cdbbd009">GetInternalRef</a> ()</td></tr>
<tr class="memdesc:a311fc36fdf7270fe05b1c531cdbbd009"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#a311fc36fdf7270fe05b1c531cdbbd009" title="GetInternalRef() retrieves an internal reference that can be safely passed across DLL boundaries and ...">GetInternalRef()</a> retrieves an internal reference that can be safely passed across DLL boundaries and reconstructed.  <a href="classTXMPFiles.html#a311fc36fdf7270fe05b1c531cdbbd009">More...</a><br /></td></tr>
<tr class="separator:a311fc36fdf7270fe05b1c531cdbbd009"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessing metadata</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions allow you to retrieve XMP metadata from open files, so that you can use the <code><a class="el" href="classTXMPMeta.html" title="API for access to the XMP Toolkit core services.">TXMPMeta</a></code> API to manipulate it. The <code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> functions update the XMP packet in memory. Changed XMP is not actually written out to the file until the file is closed. </p>
</div></td></tr>
<tr class="memitem:a42ca0bbc5ac66a8de1710e03a7ff17b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3">GetXMP</a> (SXMPMeta *xmpObj=0, tStringObj *xmpPacket=0, <a class="el" href="structXMP__PacketInfo.html">XMP_PacketInfo</a> *packetInfo=0)</td></tr>
<tr class="memdesc:a42ca0bbc5ac66a8de1710e03a7ff17b3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3" title="GetXMP() retrieves the XMP metadata from an open file.">GetXMP()</a></code> retrieves the XMP metadata from an open file.  <a href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3">More...</a><br /></td></tr>
<tr class="separator:a42ca0bbc5ac66a8de1710e03a7ff17b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3f7babdc07c7de0d0cd9a3362b4710a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a">PutXMP</a> (const SXMPMeta &amp;xmpObj)</td></tr>
<tr class="memdesc:ad3f7babdc07c7de0d0cd9a3362b4710a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file.  <a href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a">More...</a><br /></td></tr>
<tr class="separator:ad3f7babdc07c7de0d0cd9a3362b4710a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada77eab74c3440659db3122f6ec8b7f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#ada77eab74c3440659db3122f6ec8b7f4">PutXMP</a> (const tStringObj &amp;xmpPacket)</td></tr>
<tr class="memdesc:ada77eab74c3440659db3122f6ec8b7f4"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file, using a string object for input.  <a href="classTXMPFiles.html#ada77eab74c3440659db3122f6ec8b7f4">More...</a><br /></td></tr>
<tr class="separator:ada77eab74c3440659db3122f6ec8b7f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a502ed01119e0421413e773f4f42683ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a502ed01119e0421413e773f4f42683ec">PutXMP</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> xmpPacket, <a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a> xmpLength=<a class="el" href="XMP__Const_8h.html#a8283c9596c03b6d626d5a2b7a90e23ab">kXMP_UseNullTermination</a>)</td></tr>
<tr class="memdesc:a502ed01119e0421413e773f4f42683ec"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file,  <a href="classTXMPFiles.html#a502ed01119e0421413e773f4f42683ec">More...</a><br /></td></tr>
<tr class="separator:a502ed01119e0421413e773f4f42683ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29a11a1539d6300da3fb4c7e9ea02bb6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6">CanPutXMP</a> (const SXMPMeta &amp;xmpObj)</td></tr>
<tr class="memdesc:a29a11a1539d6300da3fb4c7e9ea02bb6"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet.  <a href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6">More...</a><br /></td></tr>
<tr class="separator:a29a11a1539d6300da3fb4c7e9ea02bb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3f32c2b95659ada198775e2f67c808"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a1d3f32c2b95659ada198775e2f67c808">CanPutXMP</a> (const tStringObj &amp;xmpPacket)</td></tr>
<tr class="memdesc:a1d3f32c2b95659ada198775e2f67c808"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet, passed in a string object.  <a href="classTXMPFiles.html#a1d3f32c2b95659ada198775e2f67c808">More...</a><br /></td></tr>
<tr class="separator:a1d3f32c2b95659ada198775e2f67c808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2303dfcc00f108bda202600e3da9c109"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a2303dfcc00f108bda202600e3da9c109">CanPutXMP</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> xmpPacket, <a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a> xmpLength=<a class="el" href="XMP__Const_8h.html#a8283c9596c03b6d626d5a2b7a90e23ab">kXMP_UseNullTermination</a>)</td></tr>
<tr class="memdesc:a2303dfcc00f108bda202600e3da9c109"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet, passed in a string object.  <a href="classTXMPFiles.html#a2303dfcc00f108bda202600e3da9c109">More...</a><br /></td></tr>
<tr class="separator:a2303dfcc00f108bda202600e3da9c109"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Initialization and termination</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>A <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object must be initialized before use and can be terminated when done. </p>
</div></td></tr>
<tr class="memitem:a6e521c034728b59ab55213a9d8203d1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e">GetVersionInfo</a> (<a class="el" href="structXMP__VersionInfo.html">XMP_VersionInfo</a> *versionInfo)</td></tr>
<tr class="memdesc:a6e521c034728b59ab55213a9d8203d1e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code> retrieves version information for the XMPFiles component.  <a href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e">More...</a><br /></td></tr>
<tr class="separator:a6e521c034728b59ab55213a9d8203d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0874bbbf41c9490abfb613bfe297327d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a0874bbbf41c9490abfb613bfe297327d">Initialize</a> ()</td></tr>
<tr class="memdesc:a0874bbbf41c9490abfb613bfe297327d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object.  <a href="classTXMPFiles.html#a0874bbbf41c9490abfb613bfe297327d">More...</a><br /></td></tr>
<tr class="separator:a0874bbbf41c9490abfb613bfe297327d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a794e1830a84a6328eaa1995ba5aa6874"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a794e1830a84a6328eaa1995ba5aa6874">Initialize</a> (<a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> options)</td></tr>
<tr class="memdesc:a794e1830a84a6328eaa1995ba5aa6874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object.  <a href="classTXMPFiles.html#a794e1830a84a6328eaa1995ba5aa6874">More...</a><br /></td></tr>
<tr class="separator:a794e1830a84a6328eaa1995ba5aa6874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf0defebf7ca7d2cba7aed3c5dc107df"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#abf0defebf7ca7d2cba7aed3c5dc107df">Initialize</a> (const char *pluginFolder, const char *plugins=NULL)</td></tr>
<tr class="memdesc:abf0defebf7ca7d2cba7aed3c5dc107df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object.  <a href="classTXMPFiles.html#abf0defebf7ca7d2cba7aed3c5dc107df">More...</a><br /></td></tr>
<tr class="separator:abf0defebf7ca7d2cba7aed3c5dc107df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc4b3bc2109fa98b4083df0d974f7dfb"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#acc4b3bc2109fa98b4083df0d974f7dfb">Initialize</a> (<a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> options, const char *pluginFolder, const char *plugins=NULL)</td></tr>
<tr class="memdesc:acc4b3bc2109fa98b4083df0d974f7dfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object.  <a href="classTXMPFiles.html#acc4b3bc2109fa98b4083df0d974f7dfb">More...</a><br /></td></tr>
<tr class="separator:acc4b3bc2109fa98b4083df0d974f7dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e8de80c252b60b332dc4bc524139fd8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a1e8de80c252b60b332dc4bc524139fd8">Terminate</a> ()</td></tr>
<tr class="memdesc:a1e8de80c252b60b332dc4bc524139fd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates use of the XMPFiles library.  <a href="classTXMPFiles.html#a1e8de80c252b60b332dc4bc524139fd8">More...</a><br /></td></tr>
<tr class="separator:a1e8de80c252b60b332dc4bc524139fd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">File handler information</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Call this static function from the concrete class, <code>SXMPFiles</code>, to obtain information about the file handlers for the XMPFiles component. </p>
</div></td></tr>
<tr class="memitem:a6ac78e3c7286ca8dcb41eaa007aa00e8"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a6ac78e3c7286ca8dcb41eaa007aa00e8">GetFormatInfo</a> (<a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *handlerFlags=0)</td></tr>
<tr class="memdesc:a6ac78e3c7286ca8dcb41eaa007aa00e8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#a6ac78e3c7286ca8dcb41eaa007aa00e8" title="GetFormatInfo() reports what features are supported for a specific file format.">GetFormatInfo()</a> reports what features are supported for a specific file format.  <a href="classTXMPFiles.html#a6ac78e3c7286ca8dcb41eaa007aa00e8">More...</a><br /></td></tr>
<tr class="separator:a6ac78e3c7286ca8dcb41eaa007aa00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:ae403e54b9cc5df0f59d79e31cce84e3f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#ae403e54b9cc5df0f59d79e31cce84e3f">SetClientString</a> (void *clientPtr, <a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> valuePtr, <a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a> valueLen)</td></tr>
<tr class="separator:ae403e54b9cc5df0f59d79e31cce84e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd30a5ad1765a9288e7f6ef118255a73"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#afd30a5ad1765a9288e7f6ef118255a73">SetClientStringVector</a> (void *clientPtr, <a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> *arrayPtr, XMP_Uns32 stringCount)</td></tr>
<tr class="separator:afd30a5ad1765a9288e7f6ef118255a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a5977d8094086a7c2bfa9abe03af2265c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a5977d8094086a7c2bfa9abe03af2265c">xmpFilesRef</a></td></tr>
<tr class="separator:a5977d8094086a7c2bfa9abe03af2265c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
File operations</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpea9298288a22f5c5f166a17c556b9a13"></a>These functions allow you to open, close, and query files. </p>
</td></tr>
<tr class="memitem:a07b7c4b44fb0e0a7d115ddd5ba22f926"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a07b7c4b44fb0e0a7d115ddd5ba22f926">CheckFileFormat</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath)</td></tr>
<tr class="memdesc:a07b7c4b44fb0e0a7d115ddd5ba22f926"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a07b7c4b44fb0e0a7d115ddd5ba22f926" title="CheckFileFormat() tries to determine the format of a file.">CheckFileFormat()</a></code> tries to determine the format of a file.  <a href="classTXMPFiles.html#a07b7c4b44fb0e0a7d115ddd5ba22f926">More...</a><br /></td></tr>
<tr class="separator:a07b7c4b44fb0e0a7d115ddd5ba22f926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f505664c41d7304fb757d6009b0751c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a7f505664c41d7304fb757d6009b0751c">CheckPackageFormat</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> folderPath)</td></tr>
<tr class="memdesc:a7f505664c41d7304fb757d6009b0751c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a7f505664c41d7304fb757d6009b0751c" title="CheckPackageFormat() tries to determine the format of a &quot;package&quot; folder.">CheckPackageFormat()</a></code> tries to determine the format of a "package" folder.  <a href="classTXMPFiles.html#a7f505664c41d7304fb757d6009b0751c">More...</a><br /></td></tr>
<tr class="separator:a7f505664c41d7304fb757d6009b0751c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0de588c4b98086206b3a5d737012106d"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a0de588c4b98086206b3a5d737012106d">GetFileModDate</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath, <a class="el" href="structXMP__DateTime.html">XMP_DateTime</a> *modDate, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> *format=0, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> options=0)</td></tr>
<tr class="memdesc:a0de588c4b98086206b3a5d737012106d"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a0de588c4b98086206b3a5d737012106d" title="GetFileModDate() returns the last modification date of all files that are returned by GetAssociatedRe...">GetFileModDate()</a></code> returns the last modification date of all files that are returned by <code><a class="el" href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a" title="GetAssociatedResources() returns a list of files and folders associated to filePath.">GetAssociatedResources()</a></code>  <a href="classTXMPFiles.html#a0de588c4b98086206b3a5d737012106d">More...</a><br /></td></tr>
<tr class="separator:a0de588c4b98086206b3a5d737012106d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03e6c681e827666690f0e5567b0b2a8a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a">GetAssociatedResources</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath, std::vector&lt; tStringObj &gt; *resourceList, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> options=0)</td></tr>
<tr class="memdesc:a03e6c681e827666690f0e5567b0b2a8a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a" title="GetAssociatedResources() returns a list of files and folders associated to filePath.">GetAssociatedResources()</a></code> returns a list of files and folders associated to filePath.  <a href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a">More...</a><br /></td></tr>
<tr class="separator:a03e6c681e827666690f0e5567b0b2a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dfa135d53143d45e5ff22efa554398e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a6dfa135d53143d45e5ff22efa554398e">IsMetadataWritable</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath, bool *writable, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> options=0)</td></tr>
<tr class="memdesc:a6dfa135d53143d45e5ff22efa554398e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a6dfa135d53143d45e5ff22efa554398e" title="IsMetadataWritable() returns true if metadata can be updated for the given media path.">IsMetadataWritable()</a></code> returns true if metadata can be updated for the given media path.  <a href="classTXMPFiles.html#a6dfa135d53143d45e5ff22efa554398e">More...</a><br /></td></tr>
<tr class="separator:a6dfa135d53143d45e5ff22efa554398e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcd21cfe5d6f13c648c5541e161919cb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb">OpenFile</a> (<a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> filePath, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> openFlags=0)</td></tr>
<tr class="memdesc:afcd21cfe5d6f13c648c5541e161919cb"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> opens a file for metadata access.  <a href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb">More...</a><br /></td></tr>
<tr class="separator:afcd21cfe5d6f13c648c5541e161919cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfef1688f3a62e2f465bb3a27da7b4ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#acfef1688f3a62e2f465bb3a27da7b4ac">OpenFile</a> (const tStringObj &amp;filePath, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> format=<a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a>, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> openFlags=0)</td></tr>
<tr class="memdesc:acfef1688f3a62e2f465bb3a27da7b4ac"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> opens a file for metadata access, using a string object  <a href="classTXMPFiles.html#acfef1688f3a62e2f465bb3a27da7b4ac">More...</a><br /></td></tr>
<tr class="separator:acfef1688f3a62e2f465bb3a27da7b4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeca89170c7aa3e2d56e30bff04dd7927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927">CloseFile</a> (<a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> closeFlags=0)</td></tr>
<tr class="memdesc:aeca89170c7aa3e2d56e30bff04dd7927"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a> explicitly closes an opened file.  <a href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927">More...</a><br /></td></tr>
<tr class="separator:aeca89170c7aa3e2d56e30bff04dd7927"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9931d081cb19f98c81e41786030765b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#af9931d081cb19f98c81e41786030765b">GetFileInfo</a> (tStringObj *filePath=0, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *openFlags=0, <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> *format=0, <a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *handlerFlags=0)</td></tr>
<tr class="memdesc:af9931d081cb19f98c81e41786030765b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#af9931d081cb19f98c81e41786030765b" title="GetFileInfo() retrieves basic information about an opened file.">GetFileInfo()</a></code> retrieves basic information about an opened file.  <a href="classTXMPFiles.html#af9931d081cb19f98c81e41786030765b">More...</a><br /></td></tr>
<tr class="separator:af9931d081cb19f98c81e41786030765b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b86c130fdbd54b5ac158ec3fee93777"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a7b86c130fdbd54b5ac158ec3fee93777">SetAbortProc</a> (<a class="el" href="XMP__Const_8h.html#a4db130914b233d0c7b959395c84b43b9">XMP_AbortProc</a> abortProc, void *abortArg)</td></tr>
<tr class="memdesc:a7b86c130fdbd54b5ac158ec3fee93777"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a7b86c130fdbd54b5ac158ec3fee93777" title="SetAbortProc() registers a callback function used to check for a user-signaled abort.">SetAbortProc()</a></code> registers a callback function used to check for a user-signaled abort.  <a href="classTXMPFiles.html#a7b86c130fdbd54b5ac158ec3fee93777">More...</a><br /></td></tr>
<tr class="separator:a7b86c130fdbd54b5ac158ec3fee93777"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Progress notifications</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp89f625ebe0c163ac32fbbb1a4dd476f3"></a>These functions allow track the progress of file operations. Initially only file updates are tracked, these all occur within calls to SXMPFiles::CloseFile. There are no plans to track other operations at this time. Tracking support must be added to specific file handlers, there are no guarantees about which handlers will have support. To simplify the logic only file writes will be estimated and measured. </p>
</td></tr>
<tr class="memitem:a83335ee20bb3ea543c8c86a5757a7753"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a83335ee20bb3ea543c8c86a5757a7753">SetDefaultProgressCallback</a> (<a class="el" href="XMP__Const_8h.html#a9639ef73ab21086098b0f099de248f26">XMP_ProgressReportProc</a> proc, void *context=0, float interval=1.0, bool sendStartStop=false)</td></tr>
<tr class="memdesc:a83335ee20bb3ea543c8c86a5757a7753"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#a83335ee20bb3ea543c8c86a5757a7753" title="SetDefaultProgressCallback() sets a global default for progress tracking. This is used as a default f...">SetDefaultProgressCallback()</a></code> sets a global default for progress tracking. This is used as a default for XMPFiles (library) objects created after the default is set. This does not affect the callback for new SXMPFiles (client) objects with an existing XMPFiles object.  <a href="classTXMPFiles.html#a83335ee20bb3ea543c8c86a5757a7753">More...</a><br /></td></tr>
<tr class="separator:a83335ee20bb3ea543c8c86a5757a7753"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa283e2a1c16918c86148446859ed1a2d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#aa283e2a1c16918c86148446859ed1a2d">SetProgressCallback</a> (<a class="el" href="XMP__Const_8h.html#a9639ef73ab21086098b0f099de248f26">XMP_ProgressReportProc</a> proc, void *context=0, float interval=1.0, bool sendStartStop=false)</td></tr>
<tr class="memdesc:aa283e2a1c16918c86148446859ed1a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="classTXMPFiles.html#aa283e2a1c16918c86148446859ed1a2d" title="SetProgressCallback() sets the progress notification callback for the associated XMPFiles (library) o...">SetProgressCallback()</a></code> sets the progress notification callback for the associated XMPFiles (library) object.  <a href="classTXMPFiles.html#aa283e2a1c16918c86148446859ed1a2d">More...</a><br /></td></tr>
<tr class="separator:aa283e2a1c16918c86148446859ed1a2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Error notifications</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpb9b1c1c0b1b4992a1cbdde7ae0d6e01a"></a>From the beginning through version 5.5, XMP Toolkit errors result in throwing an <code><a class="el" href="classXMP__Error.html" title="XMP Toolkit error, associates an error code with a descriptive error string.">XMP_Error</a></code> exception. For the most part exceptions were thrown early and thus API calls aborted as soon as an error was detected. Starting in version 5.5, support has been added for notifications of errors arising in calls to <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> functions.</p>
<p>A client can register an error notification callback function for a <code>TXMPFile</code> object. This can be done as a global default or individually to each object. The global default applies to all objects created after it is registered. Within the object there is no difference between the global default or explicitly registered callback. The callback function returns a <code>bool</code> value indicating if recovery should be attempted (true) or an exception thrown (false). If no callback is registered, a best effort at recovery and continuation will be made with an exception thrown if recovery is not possible.</p>
<p>The number of notifications delivered for a given <a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a> object can be limited. This is intended to reduce chatter from multiple or cascading errors. The limit is set when the callback function is registered. This limits the number of notifications of the highest severity delivered or less. If a higher severity error occurs, the counting starts again. The limit and counting can be reset at any time, see <code>ResetErrorCallbackLimit</code>. </p>
</td></tr>
<tr class="memitem:accc6c1cef9f124f6c5ed360251aa5aa7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#accc6c1cef9f124f6c5ed360251aa5aa7">SetDefaultErrorCallback</a> (<a class="el" href="XMP__Const_8h.html#a32284d1645c6d852761b107b0232c285">XMPFiles_ErrorCallbackProc</a> proc, void *context=0, XMP_Uns32 limit=1)</td></tr>
<tr class="memdesc:accc6c1cef9f124f6c5ed360251aa5aa7"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#accc6c1cef9f124f6c5ed360251aa5aa7" title="SetDefaultErrorCallback() registers a global default error notification callback.">SetDefaultErrorCallback()</a> registers a global default error notification callback.  <a href="classTXMPFiles.html#accc6c1cef9f124f6c5ed360251aa5aa7">More...</a><br /></td></tr>
<tr class="separator:accc6c1cef9f124f6c5ed360251aa5aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43a98633a0090fb4ade76edf24302ab1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a43a98633a0090fb4ade76edf24302ab1">SetErrorCallback</a> (<a class="el" href="XMP__Const_8h.html#a32284d1645c6d852761b107b0232c285">XMPFiles_ErrorCallbackProc</a> proc, void *context=0, XMP_Uns32 limit=1)</td></tr>
<tr class="memdesc:a43a98633a0090fb4ade76edf24302ab1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#a43a98633a0090fb4ade76edf24302ab1" title="SetErrorCallback() registers an error notification callback.">SetErrorCallback()</a> registers an error notification callback.  <a href="classTXMPFiles.html#a43a98633a0090fb4ade76edf24302ab1">More...</a><br /></td></tr>
<tr class="separator:a43a98633a0090fb4ade76edf24302ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e37b25dd1cba1e9a3f45037022717f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTXMPFiles.html#a8e37b25dd1cba1e9a3f45037022717f2">ResetErrorCallbackLimit</a> (XMP_Uns32 limit=1)</td></tr>
<tr class="memdesc:a8e37b25dd1cba1e9a3f45037022717f2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classTXMPFiles.html#a8e37b25dd1cba1e9a3f45037022717f2" title="ResetErrorCallbackLimit() resets the error notification limit and counting. It has no effect if an er...">ResetErrorCallbackLimit()</a> resets the error notification limit and counting. It has no effect if an error notification callback function is not registered.  <a href="classTXMPFiles.html#a8e37b25dd1cba1e9a3f45037022717f2">More...</a><br /></td></tr>
<tr class="separator:a8e37b25dd1cba1e9a3f45037022717f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class tStringObj&gt;<br />
class TXMPFiles&lt; tStringObj &gt;</h3>

<p>API for access to the main (document-level) metadata in a file. </p>
<p><code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> is a template class that provides the API for the Adobe XMP Toolkit's XMPFiles component. This provides convenient access to the main, or document level, XMP for a file. Use it to obtain metadata from a file, which you can then manipulate with the XMP Core component (the classes <code><a class="el" href="classTXMPMeta.html" title="API for access to the XMP Toolkit core services.">TXMPMeta</a></code>, <code><a class="el" href="classTXMPUtils.html" title="API for access to the XMP Toolkit utility services.">TXMPUtils</a></code>, and <code><a class="el" href="classTXMPIterator.html" title="API for access to the XMP Toolkit iteration services.">TXMPIterator</a></code>); and to write new or changed metadata back out to a file.</p>
<p>The functions allow you to open a file, read and write the metadata, then close the file. While open, portions of the file might be maintained in RAM data structures. Memory usage can vary considerably depending onfile format and access options.</p>
<p>A file can be opened for read-only or read-write access, with typical exclusion for both modes. Errors result in the throw of an <code>XMPError</code> exception.</p>
<p><code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> is the template class. It must be instantiated with a string class such as <code>std::string</code>. Read the Toolkit Overview for information about the overall architecture of the XMP API, and the documentation for <code><a class="el" href="XMP_8hpp.html" title="Overall header file for the XMP Toolkit.">XMP.hpp</a></code> for specific instantiation instructions.</p>
<p>Access these functions through the concrete class, <code>SXMPFiles</code>. </p>

<p class="definition">Definition at line <a class="el" href="TXMPFiles_8hpp_source.html#l00069">69</a> of file <a class="el" href="TXMPFiles_8hpp_source.html">TXMPFiles.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a14f01e38454178578fd25fff6024fd54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14f01e38454178578fd25fff6024fd54">&#9670;&nbsp;</a></span>TXMPFiles() <span class="overload">[1/5]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor initializes an object that is associated with no file. </p>

</div>
</div>
<a id="a5eaa92724cc82d933a32eff9c4636739"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5eaa92724cc82d933a32eff9c4636739">&#9670;&nbsp;</a></span>~TXMPFiles()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::~<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor; typical virtual destructor. </p>
<p>The destructor does not call <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code>; pending updates are lost when the destructor is run.</p>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>, <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> </dd></dl>

</div>
</div>
<a id="a36abe01988d4ca3939138e871c7b75e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36abe01988d4ca3939138e871c7b75e7">&#9670;&nbsp;</a></span>TXMPFiles() <span class="overload">[2/5]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>openFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Alternate constructor associates the new <code>XMPFiles</code> object with a specific file. </p>
<p>Calls <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> to open the specified file after performing a default construct.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>The path for the file, specified as a nul-terminated UTF-8 string.</td></tr>
    <tr><td class="paramname">format</td><td>A format hint for the file, if known.</td></tr>
    <tr><td class="paramname">openFlags</td><td>Options for how the file is to be opened (for read or read/write, for example). Use a logical OR of these bit-flag constants:</td></tr>
  </table>
  </dd>
</dl>
<ul>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa4c61ec4ed571dbc5f1832ff6772320d2" title="Open for read-only access.">kXMPFiles_OpenForRead</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa91fa388b3888bcb6a68615537b66a49b" title="Open for reading and writing.">kXMPFiles_OpenForUpdate</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaa58279b2b1311242e7374117f455bb96" title="Only the XMP is wanted, allows space/time optimizations.">kXMPFiles_OpenOnlyXMP</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa0bef4db2ecdaf82a85df9e9d417aab18" title="Be strict about only attempting to use the designated file handler, no fallback to other handlers.">kXMPFiles_OpenStrictly</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaf6332435c7fc89cb0b7381e13fe43646" title="Require the use of a smart handler.">kXMPFiles_OpenUseSmartHandler</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa77b47c63e579b28cbd25083ceb58c285" title="Force packet scanning, do not use a smart handler.">kXMPFiles_OpenUsePacketScanning</a></code> </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa77f34b1873bb2584feabe26a2c8f1182" title="Only packet scan files &quot;known&quot; to need scanning.">kXMPFiles_OpenLimitedScanning</a></code> </li>
</ul>

</div>
</div>
<a id="af540b3ea689a6d7381dca4f52132a4ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af540b3ea689a6d7381dca4f52132a4ac">&#9670;&nbsp;</a></span>TXMPFiles() <span class="overload">[3/5]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramtype">const tStringObj &amp;&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>openFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Alternate constructor associates the new <code>XMPFiles</code> object with a specific file, using a string object. </p>
<p>Overloads the basic form of the function, allowing you to pass a string object for the file path. It is otherwise identical; see details in the canonical form. </p>

</div>
</div>
<a id="acf343fb6771b482ca72d467233a6f920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf343fb6771b482ca72d467233a6f920">&#9670;&nbsp;</a></span>TXMPFiles() <span class="overload">[4/5]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt; &amp;&#160;</td>
          <td class="paramname"><em>original</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy constructor. </p>
<p>Increments an internal reference count but does not perform a deep copy.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">original</td><td>The existing <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object to copy. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad986c7b2e2d82eaef6cf6a33e9d09b65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad986c7b2e2d82eaef6cf6a33e9d09b65">&#9670;&nbsp;</a></span>TXMPFiles() <span class="overload">[5/5]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::<a class="el" href="classTXMPFiles.html">TXMPFiles</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a>&#160;</td>
          <td class="paramname"><em>xmpFilesObj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reconstructs a <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object from an internal reference. </p>
<p>This constructor creates a new <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object that refers to the underlying reference object of an existing <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object. Use to safely pass <code>SXMPFiles</code> references across DLL boundaries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpFilesObj</td><td>The underlying reference object, obtained from some other XMP object with <code><a class="el" href="classTXMPFiles.html#a311fc36fdf7270fe05b1c531cdbbd009" title="GetInternalRef() retrieves an internal reference that can be safely passed across DLL boundaries and ...">TXMPFiles::GetInternalRef()</a></code>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a29a11a1539d6300da3fb4c7e9ea02bb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29a11a1539d6300da3fb4c7e9ea02bb6">&#9670;&nbsp;</a></span>CanPutXMP() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CanPutXMP </td>
          <td>(</td>
          <td class="paramtype">const SXMPMeta &amp;&#160;</td>
          <td class="paramname"><em>xmpObj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet. </p>
<p>Use to determine if the file can probably be updated with a given set of XMP metadata. This depends on the size of the packet, the options with which the file was opened, and the capabilities of the handler for the file format. The function obtains the length of the serialized packet for the provided XMP, but does not keep it or modify it, and does not cause the file to be written when closed. This is implemented roughly as follows:</p>
<pre>
bool CanPutXMP ( XMP_StringPtr xmpPacket )
{
   XMP_FileFormat format;
   this-&gt;GetFileInfo ( 0, &amp;format, 0 );</pre><pre>   XMP_OptionBits formatFlags;
   GetFormatInfo ( format, &amp;formatFlags );</pre><pre>   if ( (formatFlags &amp; kXMPFiles_CanInjectXMP) &amp;&amp; (formatFlags &amp; kXMPFiles_CanExpand) ) return true;</pre><pre>   <a class="el" href="structXMP__PacketInfo.html" title="XMP packet description.">XMP_PacketInfo</a> packetInfo;
   bool hasXMP = this-&gt;GetXMP ( 0, 0, &amp;packetInfo );</pre><pre>   if ( ! hasXMP ) {
      if ( formatFlags &amp; kXMPFiles_CanInjectXMP ) return true;
   } else {
      if ( (formatFlags &amp; kXMPFiles_CanExpand) ||
           (packetInfo.length &gt;= strlen(xmpPacket)) ) return true;
   }
   return false;
}
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpObj</td><td>The proposed new metadata as an XMP object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a1d3f32c2b95659ada198775e2f67c808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3f32c2b95659ada198775e2f67c808">&#9670;&nbsp;</a></span>CanPutXMP() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CanPutXMP </td>
          <td>(</td>
          <td class="paramtype">const tStringObj &amp;&#160;</td>
          <td class="paramname"><em>xmpPacket</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet, passed in a string object. </p>
<p>Overloads the basic form of the function, allowing you to pass the metadata as a string object instead of an XMP object. It is otherwise identical; see details in the canonical form.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpPacket</td><td>The proposed new metadata as a string object containing an XMP packet. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2303dfcc00f108bda202600e3da9c109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2303dfcc00f108bda202600e3da9c109">&#9670;&nbsp;</a></span>CanPutXMP() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CanPutXMP </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>xmpPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a>&#160;</td>
          <td class="paramname"><em>xmpLength</em> = <code><a class="el" href="XMP__Const_8h.html#a8283c9596c03b6d626d5a2b7a90e23ab">kXMP_UseNullTermination</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a29a11a1539d6300da3fb4c7e9ea02bb6" title="CanPutXMP() reports whether this file can be updated with a specific XMP packet.">CanPutXMP()</a></code> reports whether this file can be updated with a specific XMP packet, passed in a string object. </p>
<p>Overloads the basic form of the function, allowing you to pass the metadata as a string object instead of an XMP object. It is otherwise identical; see details in the canonical form.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpPacket</td><td>The proposed new metadata as a <code>const char *</code> string containing an XMP packet.</td></tr>
    <tr><td class="paramname">xmpLength</td><td>Optional. The number of bytes in the string. If not supplied, the string is assumed to be nul-terminated. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a07b7c4b44fb0e0a7d115ddd5ba22f926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07b7c4b44fb0e0a7d115ddd5ba22f926">&#9670;&nbsp;</a></span>CheckFileFormat()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CheckFileFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a07b7c4b44fb0e0a7d115ddd5ba22f926" title="CheckFileFormat() tries to determine the format of a file.">CheckFileFormat()</a></code> tries to determine the format of a file. </p>
<p>Tries to determine the format of a file, returning an <code><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e" title="Type for file format identification constants. See kXMP_PDFFile and following.">XMP_FileFormat</a></code> value. Uses the same logic as <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> to select a smart handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>The path for the file, appropriate for the local operating system. Passed as a nul-terminated UTF-8 string. The path is the same as would be passed to <code>OpenFile</code>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The file's format if a smart handler would be selected by <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>, otherwise <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719" title="Unknown file format constant: &#39; &#39;.">kXMP_UnknownFile</a></code>. </dd></dl>

</div>
</div>
<a id="a7f505664c41d7304fb757d6009b0751c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f505664c41d7304fb757d6009b0751c">&#9670;&nbsp;</a></span>CheckPackageFormat()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CheckPackageFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>folderPath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a7f505664c41d7304fb757d6009b0751c" title="CheckPackageFormat() tries to determine the format of a &quot;package&quot; folder.">CheckPackageFormat()</a></code> tries to determine the format of a "package" folder. </p>
<p>Tries to determine the format of a package, given the name of the top-level folder. Returns an <code><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e" title="Type for file format identification constants. See kXMP_PDFFile and following.">XMP_FileFormat</a></code> value. Examples of recognized packages include the video formats P2, XDCAM, or Sony HDV. These packages contain collections of "clips", stored as multiple files in specific subfolders.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">folderPath</td><td>The path for the top-level folder, appropriate for the local operating system. Passed as a nul-terminated UTF-8 string. This is not the same path you would pass to <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>. For example, the top-level path for a package might be ".../MyMovie", while the path to a file you wish to open would be ".../MyMovie/SomeClip".</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The package's format if it can be determined, otherwise <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719" title="Unknown file format constant: &#39; &#39;.">kXMP_UnknownFile</a></code>. </dd></dl>

</div>
</div>
<a id="aeca89170c7aa3e2d56e30bff04dd7927"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeca89170c7aa3e2d56e30bff04dd7927">&#9670;&nbsp;</a></span>CloseFile()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::CloseFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>closeFlags</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a> explicitly closes an opened file. </p>
<p>Performs any necessary output to the file and closes it. Files that are opened for update are written to only when closing.</p>
<p>If the file is opened for read-only access (passing <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa4c61ec4ed571dbc5f1832ff6772320d2" title="Open for read-only access.">kXMPFiles_OpenForRead</a></code>), the disk file is closed immediately after reading the data from it; the <code>XMPFiles</code> object, however, remains in the open state. You must call <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> when finished using it. Other methods, such as <code><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3" title="GetXMP() retrieves the XMP metadata from an open file.">GetXMP()</a></code>, can only be used between the <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> and <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> calls. The <code>XMPFiles</code> destructor does not call <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code>; if you call it without closing, any pending updates are lost.</p>
<p>If the file is opened for update (passing <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa91fa388b3888bcb6a68615537b66a49b" title="Open for reading and writing.">kXMPFiles_OpenForUpdate</a></code>), the disk file remains open until <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> is called. The disk file is only updated once, when <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> is called, regardless of how many calls are made to <code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">closeFlags</td><td>Option flags for optional closing actions. This bit-flag constant is defined:</td></tr>
  </table>
  </dd>
</dl>
<ul>
<li><code><a class="el" href="XMP__Const_8h.html#a6b7b47dd702d9e331586d485013fd1eaadbf8d744f355ef9800a4ec44325baf54" title="Write into a temporary file and swap for crash safety.">kXMPFiles_UpdateSafely</a></code> - Write into a temporary file then swap for crash safety. </li>
</ul>

</div>
</div>
<a id="a03e6c681e827666690f0e5567b0b2a8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03e6c681e827666690f0e5567b0b2a8a">&#9670;&nbsp;</a></span>GetAssociatedResources()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetAssociatedResources </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; tStringObj &gt; *&#160;</td>
          <td class="paramname"><em>resourceList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>options</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a" title="GetAssociatedResources() returns a list of files and folders associated to filePath.">GetAssociatedResources()</a></code> returns a list of files and folders associated to filePath. </p>
<p><code>GetAssociatedResources</code> is provided to locate all files that are associated to the given filePath such as sidecar-based XMP or folder-based video packages.If a smart handler can be selected (not fallback packet scanning) then a list of file/folder paths is returned for the related files that can be safely copied/imported to a different location, keeping intact metadata(XMP and non-XMP),content and the necessary folder structure of the format. The necessary folder structure here is the structure that is needed to uniquely identify a folder-based format.The filePath and format parameters are exactly as would be used for OpenFile. In the simple embedded XMP case just one path is returned. In the simple sidecar case one or two paths will be returned, one if there is no sidecar XMP and two if sidecar XMP exists. For folder-based handlers paths to all associated files is returned, including the files and folders necessary to identify the format.In general, all the returned paths are existent.In case of folder based video formats the first associated resource in the <br  />
 resourceList is the root folder. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>A path exactly as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">resourceList</td><td>Address of a vector of strings to receive all associated resource paths.</td></tr>
    <tr><td class="paramname">format</td><td>A format hint as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">options</td><td>An optional set of option flags. The only defined one is <code>kXMPFiles_ForceGivenHandler</code>, used to shortcut the handler selection logic if the caller is certain of the format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file path is valid to select a smart handler, false for an invalid path or if fallback packet scanning would be selected. Can also return false for unexpected errors that prevent knowledge of the file usage. </dd></dl>

</div>
</div>
<a id="af9931d081cb19f98c81e41786030765b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9931d081cb19f98c81e41786030765b">&#9670;&nbsp;</a></span>GetFileInfo()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetFileInfo </td>
          <td>(</td>
          <td class="paramtype">tStringObj *&#160;</td>
          <td class="paramname"><em>filePath</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *&#160;</td>
          <td class="paramname"><em>openFlags</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> *&#160;</td>
          <td class="paramname"><em>format</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *&#160;</td>
          <td class="paramname"><em>handlerFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#af9931d081cb19f98c81e41786030765b" title="GetFileInfo() retrieves basic information about an opened file.">GetFileInfo()</a></code> retrieves basic information about an opened file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>[out] A buffer in which to return the path passed to <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>. Can be null if value is not wanted.</td></tr>
    <tr><td class="paramname">openFlags</td><td>[out] A buffer in which to return the option flags passed to <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>. Can be null if value is not wanted.</td></tr>
    <tr><td class="paramname">format</td><td>[out] A buffer in which to return the file format. Can be null if value is not wanted. </td></tr>
    <tr><td class="paramname">handlerFlags</td><td>[out] A buffer in which to return the handler's capability flags. Can be null if value is not wanted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the file object is in the open state; that is, <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> has been called but <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> has not. False otherwise. Even if the file object is open, the actual disk file might be closed in the host file-system sense; see <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code>. </dd></dl>

</div>
</div>
<a id="a0de588c4b98086206b3a5d737012106d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0de588c4b98086206b3a5d737012106d">&#9670;&nbsp;</a></span>GetFileModDate()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetFileModDate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structXMP__DateTime.html">XMP_DateTime</a> *&#160;</td>
          <td class="paramname"><em>modDate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a> *&#160;</td>
          <td class="paramname"><em>format</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>options</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a0de588c4b98086206b3a5d737012106d" title="GetFileModDate() returns the last modification date of all files that are returned by GetAssociatedRe...">GetFileModDate()</a></code> returns the last modification date of all files that are returned by <code><a class="el" href="classTXMPFiles.html#a03e6c681e827666690f0e5567b0b2a8a" title="GetAssociatedResources() returns a list of files and folders associated to filePath.">GetAssociatedResources()</a></code> </p>
<p>Returns the most recent O/S file modification date of all associated files. In the typical case of a single file containing embedded XMP, returned date value is the modification date of the same file. For sidecar and folder based video packages, returned date value is the modification date of that associated file which was updated last.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>A path exactly as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">modDate</td><td>A required pointer to return the last modification date.</td></tr>
    <tr><td class="paramname">format</td><td>A format hint as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">options</td><td>An optional set of option flags. The only defined one is <code>kXMPFiles_ForceGivenHandler</code>, used to shortcut the handler selection logic if the caller is certain of the format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file path is valid to select a smart handler, false for an invalid path or if fallback packet scanning would be selected. <br  />
 </dd></dl>

</div>
</div>
<a id="a6ac78e3c7286ca8dcb41eaa007aa00e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ac78e3c7286ca8dcb41eaa007aa00e8">&#9670;&nbsp;</a></span>GetFormatInfo()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetFormatInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a> *&#160;</td>
          <td class="paramname"><em>handlerFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#a6ac78e3c7286ca8dcb41eaa007aa00e8" title="GetFormatInfo() reports what features are supported for a specific file format.">GetFormatInfo()</a> reports what features are supported for a specific file format. </p>
<p>The file handlers for different file formats vary considerably in what features they support. Support depends on both the general capabilities of the format and the implementation of the handler for that format.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>The file format whose support flags are desired.</td></tr>
    <tr><td class="paramname">handlerFlags</td><td>[out] A buffer in which to return a logical OR of option bit flags. The following constants are defined:</td></tr>
  </table>
  </dd>
</dl>
<ul>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fcea23a3eb2a5e95292036a93ad6666fa388" title="Can inject first-time XMP into an existing file.">kXMPFiles_CanInjectXMP</a></code> - Can inject first-time XMP into an existing file. </li>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fcea126c9cc056f6569c424431edbcb9521c" title="Can expand XMP or other metadata in an existing file.">kXMPFiles_CanExpand</a></code> - Can expand XMP or other metadata in an existing file. </li>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fcea8957f1ef358b4ab3a1df519903f2ae07" title="Can copy one file to another, writing new metadata.">kXMPFiles_CanRewrite</a></code> - Can copy one file to another, writing new metadata (as in SaveAs) </li>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fceafc2bc7cfdd28a326788d563ec0357694" title="Supports reconciliation between XMP and other forms.">kXMPFiles_CanReconcile</a></code> - Supports reconciliation between XMP and other forms. </li>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fcea4a183c3ec4994cf09993e5b31dee9733" title="Allows access to just the XMP, ignoring other forms.">kXMPFiles_AllowsOnlyXMP</a></code> - Allows access to just the XMP, ignoring other forms. This is only meaningful if <code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fceafc2bc7cfdd28a326788d563ec0357694" title="Supports reconciliation between XMP and other forms.">kXMPFiles_CanReconcile</a></code> is set. </li>
<li><code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fceadb116eed738d1fcdfe4ab9c1635e08ea" title="File handler returns raw XMP packet information.">kXMPFiles_ReturnsRawPacket</a></code> - File handler returns raw XMP packet information and string.</li>
</ul>
<p>Even if <code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fceadb116eed738d1fcdfe4ab9c1635e08ea" title="File handler returns raw XMP packet information.">kXMPFiles_ReturnsRawPacket</a></code> is set, the returned packet information might have an offset of -1 to indicate an unknown offset. While all file handlers should be able to return the raw packet, some might not know the offset of the packet within the file. This is typical in cases where external libraries are used. These cases might not even allow return of the raw packet.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the format has explicit "smart" support, false if the format is handled by the default packet scanning plus heuristics. *&zwj;/ </dd></dl>

</div>
</div>
<a id="a311fc36fdf7270fe05b1c531cdbbd009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a311fc36fdf7270fe05b1c531cdbbd009">&#9670;&nbsp;</a></span>GetInternalRef()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a> <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetInternalRef </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#a311fc36fdf7270fe05b1c531cdbbd009" title="GetInternalRef() retrieves an internal reference that can be safely passed across DLL boundaries and ...">GetInternalRef()</a> retrieves an internal reference that can be safely passed across DLL boundaries and reconstructed. </p>
<p>Use with the reconstruction constructor to safely pass <code>SXMPFiles</code> references across DLL boundaries where the clients might have used different string types when instantiating <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code>.</p>
<dl class="section return"><dt>Returns</dt><dd>The internal reference.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classTXMPMeta.html#a4d35b44f1f017a27772ee902a3dacf04" title="Retrieves an internal reference that can be safely passed across DLL boundaries and reconstructed.">TXMPMeta::GetInternalRef()</a></code> for usage. </dd></dl>

</div>
</div>
<a id="a6e521c034728b59ab55213a9d8203d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e521c034728b59ab55213a9d8203d1e">&#9670;&nbsp;</a></span>GetVersionInfo()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetVersionInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structXMP__VersionInfo.html">XMP_VersionInfo</a> *&#160;</td>
          <td class="paramname"><em>versionInfo</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code> retrieves version information for the XMPFiles component. </p>
<p>Can be called before <code><a class="el" href="classTXMPFiles.html#a0874bbbf41c9490abfb613bfe297327d" title="Initializes the XMPFiles library; must be called before creating an SXMPFiles object.">Initialize()</a></code>. This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">versionInfo</td><td>[out] A buffer in which to return the version information. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a42ca0bbc5ac66a8de1710e03a7ff17b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42ca0bbc5ac66a8de1710e03a7ff17b3">&#9670;&nbsp;</a></span>GetXMP()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::GetXMP </td>
          <td>(</td>
          <td class="paramtype">SXMPMeta *&#160;</td>
          <td class="paramname"><em>xmpObj</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">tStringObj *&#160;</td>
          <td class="paramname"><em>xmpPacket</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structXMP__PacketInfo.html">XMP_PacketInfo</a> *&#160;</td>
          <td class="paramname"><em>packetInfo</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3" title="GetXMP() retrieves the XMP metadata from an open file.">GetXMP()</a></code> retrieves the XMP metadata from an open file. </p>
<p>The function reports whether XMP is present in the file; you can choose to retrieve any or all of the parsed XMP, the raw XMP packet,or information about the raw XMP packet. The options provided when the file was opened determine if reconciliation is done with other forms of metadata.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpObj</td><td>[out] An XMP object in which to return the parsed XMP metadata. Can be null.</td></tr>
    <tr><td class="paramname">xmpPacket</td><td>[out] An string object in which to return the raw XMP packet as stored in the file. Can be null. The encoding of the packet is given in the <code>packetInfo</code>. Returns an empty string if the low level file handler does not provide the raw packet.</td></tr>
    <tr><td class="paramname">packetInfo</td><td>[out] An string object in which to return the location and form of the raw XMP in the file. <code><a class="el" href="structXMP__PacketInfo.html#a039ce6665fe8e08d922a46f266799f75" title="Character format using the values kXMP_Char8Bit, kXMP_Char16BitBig, etc.">XMP_PacketInfo::charForm</a></code> and <code><a class="el" href="structXMP__PacketInfo.html#a66845c1d5f3f9f36a1543a7322bd7bd1" title="True if there is a packet wrapper and the trailer says writeable by dumb packet scanners.">XMP_PacketInfo::writeable</a></code> reflect the raw XMP in the file. The parsed XMP property values are always UTF-8. The writeable flag is taken from the packet trailer; it applies only to "format ignorant" writing. The <code><a class="el" href="structXMP__PacketInfo.html" title="XMP packet description.">XMP_PacketInfo</a></code> structure always reflects the state of the XMP in the file. The offset, length, and character form do not change as a result of calling <code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> unless the file is also written. Some file handlers might not return location or contents of the raw packet string. To determine whether one does, check the <code><a class="el" href="XMP__Const_8h.html#aaf105ae5beaca1dee30ae54530691fceadb116eed738d1fcdfe4ab9c1635e08ea" title="File handler returns raw XMP packet information.">kXMPFiles_ReturnsRawPacket</a></code> bit returned by <code><a class="el" href="classTXMPFiles.html#a6ac78e3c7286ca8dcb41eaa007aa00e8" title="GetFormatInfo() reports what features are supported for a specific file format.">GetFormatInfo()</a></code>. If the low-level file handler does not provide the raw packet location, <code><a class="el" href="structXMP__PacketInfo.html#a20f65fcfd0f3658ab93ff441a9d61d2c" title="Packet offset in the file in bytes, -1 if unknown.">XMP_PacketInfo::offset</a></code> and <code><a class="el" href="structXMP__PacketInfo.html#af526c582b66e24553f2d4b11eb714a44" title="Packet length in the file in bytes, -1 if unknown.">XMP_PacketInfo::length</a></code> are both 0, <code><a class="el" href="structXMP__PacketInfo.html#a039ce6665fe8e08d922a46f266799f75" title="Character format using the values kXMP_Char8Bit, kXMP_Char16BitBig, etc.">XMP_PacketInfo::charForm</a></code> is UTF-8, and <code><a class="el" href="structXMP__PacketInfo.html#a66845c1d5f3f9f36a1543a7322bd7bd1" title="True if there is a packet wrapper and the trailer says writeable by dumb packet scanners.">XMP_PacketInfo::writeable</a></code> is false.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the file has XMP, false otherwise. </dd></dl>

</div>
</div>
<a id="a0874bbbf41c9490abfb613bfe297327d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0874bbbf41c9490abfb613bfe297327d">&#9670;&nbsp;</a></span>Initialize() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::Initialize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object. </p>
<p>The main action is to activate the available smart file handlers. Must be called before using any methods except <code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code>.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<a id="abf0defebf7ca7d2cba7aed3c5dc107df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf0defebf7ca7d2cba7aed3c5dc107df">&#9670;&nbsp;</a></span>Initialize() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::Initialize </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pluginFolder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>plugins</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object. </p>
<p>This overload of <a class="el" href="classTXMPFiles.html#a0874bbbf41c9490abfb613bfe297327d" title="Initializes the XMPFiles library; must be called before creating an SXMPFiles object.">TXMPFiles::Initialize()</a> accepts plugin directory and name of the plug-ins as a comma separated list to load the file handler plug-ins. If plugins == NULL, then all plug-ins present in the plug-in directory will be loaded.</p>
<p>The main action is to activate the available smart file handlers. Must be called before using any methods except <code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code>.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pluginFolder</td><td>Pugin directorty to load the file handler plug-ins. </td></tr>
    <tr><td class="paramname">plugins</td><td>Comma sepearted list of plug-ins which should be loaded from the plug-in directory. If plugin == NULL, then all plug-ins availbale in the plug-in directory will be loaded.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<a id="a794e1830a84a6328eaa1995ba5aa6874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a794e1830a84a6328eaa1995ba5aa6874">&#9670;&nbsp;</a></span>Initialize() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>options</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object. </p>
<p>This overload of <a class="el" href="classTXMPFiles.html#a0874bbbf41c9490abfb613bfe297327d" title="Initializes the XMPFiles library; must be called before creating an SXMPFiles object.">TXMPFiles::Initialize()</a> accepts option bits to customize the initialization actions. At this time no option is defined.</p>
<p>The main action is to activate the available smart file handlers. Must be called before using any methods except <code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code>.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">options</td><td>Option flags to control the initialization actions.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<a id="acc4b3bc2109fa98b4083df0d974f7dfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc4b3bc2109fa98b4083df0d974f7dfb">&#9670;&nbsp;</a></span>Initialize() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pluginFolder</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>plugins</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initializes the XMPFiles library; must be called before creating an <code>SXMPFiles</code> object. </p>
<p>This overload of <a class="el" href="classTXMPFiles.html#a794e1830a84a6328eaa1995ba5aa6874" title="Initializes the XMPFiles library; must be called before creating an SXMPFiles object.">TXMPFiles::Initialize( XMP_OptionBits options )</a> accepts plugin directory and name of the plug-ins as a comma separated list to load the file handler plug-ins. If plugins == NULL, then all plug-ins present in the plug-in directory will be loaded.</p>
<p>The main action is to activate the available smart file handlers. Must be called before using any methods except <code><a class="el" href="classTXMPFiles.html#a6e521c034728b59ab55213a9d8203d1e" title="GetVersionInfo() retrieves version information for the XMPFiles component.">GetVersionInfo()</a></code>.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">options</td><td>Option flags to control the initialization actions. </td></tr>
    <tr><td class="paramname">pluginFolder</td><td>Pugin directorty to load the file handler plug-ins. </td></tr>
    <tr><td class="paramname">plugins</td><td>Comma sepearted list of plug-ins which should be loaded from the plug-in directory. If plugin == NULL, then all plug-ins availbale in the plug-in directory will be loaded.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<a id="a6dfa135d53143d45e5ff22efa554398e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dfa135d53143d45e5ff22efa554398e">&#9670;&nbsp;</a></span>IsMetadataWritable()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::IsMetadataWritable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>writable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>options</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a6dfa135d53143d45e5ff22efa554398e" title="IsMetadataWritable() returns true if metadata can be updated for the given media path.">IsMetadataWritable()</a></code> returns true if metadata can be updated for the given media path. </p>
<p><code>IsMetadataWritable</code> is provided to check if metadata can be updated or written to the format.In <br  />
 the case of folder-based video formats only if all the metadata files can be written to, true is returned.In other words, false is returned for a partial-write state of metadata files in folder-based media formats.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>A path exactly as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">writable</td><td>A pointer to the result flag. Is true if the metadata can be updated in the format, otherwise false.</td></tr>
    <tr><td class="paramname">format</td><td>A format hint as would be passed to <code>OpenFile</code>.</td></tr>
    <tr><td class="paramname">options</td><td>An optional set of option flags. The only defined one is <code>kXMPFiles_ForceGivenHandler</code>, used to shortcut the handler selection logic if the caller is certain of the format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file path is valid to select a smart handler, false for an invalid path or if fallback packet scanning would be selected. <br  />
 </dd></dl>

</div>
</div>
<a id="acfef1688f3a62e2f465bb3a27da7b4ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfef1688f3a62e2f465bb3a27da7b4ac">&#9670;&nbsp;</a></span>OpenFile() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::OpenFile </td>
          <td>(</td>
          <td class="paramtype">const tStringObj &amp;&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>openFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> opens a file for metadata access, using a string object </p>
<p>Overloads the basic form of the function, allowing you to pass a string object for the file path. It is otherwise identical; see details in the canonical form. </p>

</div>
</div>
<a id="afcd21cfe5d6f13c648c5541e161919cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcd21cfe5d6f13c648c5541e161919cb">&#9670;&nbsp;</a></span>OpenFile() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::OpenFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>filePath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a300d9a9189cb4ddb6970d05389f5c28e">XMP_FileFormat</a>&#160;</td>
          <td class="paramname"><em>format</em> = <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719">kXMP_UnknownFile</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#aeb865118433be92d88e5f49ed11487c8">XMP_OptionBits</a>&#160;</td>
          <td class="paramname"><em>openFlags</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> opens a file for metadata access. </p>
<p>Opens a file for the requested forms of metadata access. Opening the file at a minimum causes the raw XMP packet to be read from the file. If the file handler supports legacy metadata reconciliation then legacy metadata is also read, unless <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaa58279b2b1311242e7374117f455bb96" title="Only the XMP is wanted, allows space/time optimizations.">kXMPFiles_OpenOnlyXMP</a></code> is passed.</p>
<p>If the file is opened for read-only access (passing <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa4c61ec4ed571dbc5f1832ff6772320d2" title="Open for read-only access.">kXMPFiles_OpenForRead</a></code>), the disk file is closed immediately after reading the data from it; the <code>XMPFiles</code> object, however, remains in the open state. You must call <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> when finished using it. Other methods, such as <code><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3" title="GetXMP() retrieves the XMP metadata from an open file.">GetXMP()</a></code>, can only be used between the <code><a class="el" href="classTXMPFiles.html#afcd21cfe5d6f13c648c5541e161919cb" title="OpenFile() opens a file for metadata access.">OpenFile()</a></code> and <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> calls. The <code>XMPFiles</code> destructor does not call <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code>; if you call it without closing, any pending updates are lost.</p>
<p>If the file is opened for update (passing <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa91fa388b3888bcb6a68615537b66a49b" title="Open for reading and writing.">kXMPFiles_OpenForUpdate</a></code>), the disk file remains open until <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> is called. The disk file is only updated once, when <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code> is called, regardless of how many calls are made to <code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code>.</p>
<p>Typically, the XMP is not parsed and legacy reconciliation is not performed until <code><a class="el" href="classTXMPFiles.html#a42ca0bbc5ac66a8de1710e03a7ff17b3" title="GetXMP() retrieves the XMP metadata from an open file.">GetXMP()</a></code> is called, but this is not guaranteed. Specific file handlers might do earlier parsing of the XMP. Delayed parsing and early disk file close for read-only access are optimizations to help clients implementing file browsers, so that they can access the file briefly and possibly display a thumbnail, then postpone more expensive XMP processing until later.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>The path for the file, appropriate for the local operating system. Passed as a nul-terminated UTF-8 string.</td></tr>
    <tr><td class="paramname">format</td><td>The format of the file. If the format is unknown (<code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719" title="Unknown file format constant: &#39; &#39;.">kXMP_UnknownFile</a></code>) the format is determined from the file content. The first handler to check is guessed from the file's extension. Passing a specific format value is generally just a hint about what file handler to try first (instead of the one based on the extension). If <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa0bef4db2ecdaf82a85df9e9d417aab18" title="Be strict about only attempting to use the designated file handler, no fallback to other handlers.">kXMPFiles_OpenStrictly</a></code> is set, then any format other than <code><a class="el" href="XMP__Const_8h.html#abc5c98fcc1211af2b80116dd6e0a035da2845f95eaaaf492f5011bff05a398719" title="Unknown file format constant: &#39; &#39;.">kXMP_UnknownFile</a></code> requires that the file actually be that format; otherwise an exception is thrown.</td></tr>
    <tr><td class="paramname">openFlags</td><td>A set of option flags that describe the desired access. By default (zero) the file is opened for read-only access and the format handler decides on the level of reconciliation that will be performed. A logical OR of these bit-flag constants:</td></tr>
  </table>
  </dd>
</dl>
<ul>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa4c61ec4ed571dbc5f1832ff6772320d2" title="Open for read-only access.">kXMPFiles_OpenForRead</a></code> - Open for read-only access. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa91fa388b3888bcb6a68615537b66a49b" title="Open for reading and writing.">kXMPFiles_OpenForUpdate</a></code> - Open for reading and writing. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaa58279b2b1311242e7374117f455bb96" title="Only the XMP is wanted, allows space/time optimizations.">kXMPFiles_OpenOnlyXMP</a></code> - Only the XMP is wanted, no reconciliation. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa0bef4db2ecdaf82a85df9e9d417aab18" title="Be strict about only attempting to use the designated file handler, no fallback to other handlers.">kXMPFiles_OpenStrictly</a></code> - Be strict about locating XMP and reconciling with other forms. By default, a best effort is made to locate the correct XMP and to reconcile XMP with other forms (if reconciliation is done). This option forces stricter rules, resulting in exceptions for errors. The definition of strictness is specific to each handler, there might be no difference. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaf6332435c7fc89cb0b7381e13fe43646" title="Require the use of a smart handler.">kXMPFiles_OpenUseSmartHandler</a></code> - Require the use of a smart handler. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaa77b47c63e579b28cbd25083ceb58c285" title="Force packet scanning, do not use a smart handler.">kXMPFiles_OpenUsePacketScanning</a></code> - Force packet scanning, do not use a smart handler. </li>
<li><code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaf5f2ebd401758a14dc52c5ee403303b5" title="When updating a file, spend the effort necessary to optimize file layout.">kXMPFiles_OptimizeFileLayout</a></code> - When updating a file, spend the effort necessary to optimize file layout. <dl class="section return"><dt>Returns</dt><dd>True if the file is succesfully opened and attached to a file handler. False for anticipated problems, such as passing <code><a class="el" href="XMP__Const_8h.html#a80155586fa275b28773c9b203f52cabaaf6332435c7fc89cb0b7381e13fe43646" title="Require the use of a smart handler.">kXMPFiles_OpenUseSmartHandler</a></code> but not having an appropriate smart handler. Throws an exception for serious problems. </dd></dl>
</li>
</ul>

</div>
</div>
<a id="a3f1483fcc92860460d3772216dfaef81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f1483fcc92860460d3772216dfaef81">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt; &amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Assignment operator. </p>
<p>Increments an internal reference count but does not perform a deep copy.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rhs</td><td>The existing <code><a class="el" href="classTXMPFiles.html" title="API for access to the main (document-level) metadata in a file.">TXMPFiles</a></code> object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad3f7babdc07c7de0d0cd9a3362b4710a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3f7babdc07c7de0d0cd9a3362b4710a">&#9670;&nbsp;</a></span>PutXMP() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::PutXMP </td>
          <td>(</td>
          <td class="paramtype">const SXMPMeta &amp;&#160;</td>
          <td class="paramname"><em>xmpObj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file. </p>
<p>This function supplies new XMP for the file. However, the disk file is not written until the object is closed with <code><a class="el" href="classTXMPFiles.html#aeca89170c7aa3e2d56e30bff04dd7927" title="CloseFile() explicitly closes an opened file.">CloseFile()</a></code>. The options provided when the file was opened determine if reconciliation is done with other forms of metadata.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpObj</td><td>The new metadata as an XMP object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ada77eab74c3440659db3122f6ec8b7f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada77eab74c3440659db3122f6ec8b7f4">&#9670;&nbsp;</a></span>PutXMP() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::PutXMP </td>
          <td>(</td>
          <td class="paramtype">const tStringObj &amp;&#160;</td>
          <td class="paramname"><em>xmpPacket</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file, using a string object for input. </p>
<p>Overloads the basic form of the function, allowing you to pass the metadata as a string object instead of an XMP object. It is otherwise identical; see details in the canonical form.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpPacket</td><td>The new metadata as a string object containing a complete XMP packet. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a502ed01119e0421413e773f4f42683ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a502ed01119e0421413e773f4f42683ec">&#9670;&nbsp;</a></span>PutXMP() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::PutXMP </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>xmpPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a>&#160;</td>
          <td class="paramname"><em>xmpLength</em> = <code><a class="el" href="XMP__Const_8h.html#a8283c9596c03b6d626d5a2b7a90e23ab">kXMP_UseNullTermination</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#ad3f7babdc07c7de0d0cd9a3362b4710a" title="PutXMP() updates the XMP metadata in this object without writing out the file.">PutXMP()</a></code> updates the XMP metadata in this object without writing out the file, </p>
<p>using a string object and optional length. Overloads the basic form of the function, allowing you to pass the metadata as a string object instead of an XMP object. It is otherwise identical; see details in the canonical form.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmpPacket</td><td>The new metadata as a <code>const char *</code> string containing an XMP packet.</td></tr>
    <tr><td class="paramname">xmpLength</td><td>Optional. The number of bytes in the string. If not supplied, the string is assumed to be nul-terminated. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8e37b25dd1cba1e9a3f45037022717f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e37b25dd1cba1e9a3f45037022717f2">&#9670;&nbsp;</a></span>ResetErrorCallbackLimit()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::ResetErrorCallbackLimit </td>
          <td>(</td>
          <td class="paramtype">XMP_Uns32&#160;</td>
          <td class="paramname"><em>limit</em> = <code>1</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#a8e37b25dd1cba1e9a3f45037022717f2" title="ResetErrorCallbackLimit() resets the error notification limit and counting. It has no effect if an er...">ResetErrorCallbackLimit()</a> resets the error notification limit and counting. It has no effect if an error notification callback function is not registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">limit</td><td>A limit on the number of notifications to be delivered. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7b86c130fdbd54b5ac158ec3fee93777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b86c130fdbd54b5ac158ec3fee93777">&#9670;&nbsp;</a></span>SetAbortProc()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetAbortProc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a4db130914b233d0c7b959395c84b43b9">XMP_AbortProc</a>&#160;</td>
          <td class="paramname"><em>abortProc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>abortArg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a7b86c130fdbd54b5ac158ec3fee93777" title="SetAbortProc() registers a callback function used to check for a user-signaled abort.">SetAbortProc()</a></code> registers a callback function used to check for a user-signaled abort. </p>
<p>The specified procedure is called periodically to allow a user to cancel time-consuming operations. The callback function should return true to signal an abort, which results in an exception being thrown.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">abortProc</td><td>The callback function.</td></tr>
    <tr><td class="paramname">abortArg</td><td>A pointer to caller-defined data to pass to the callback function. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae403e54b9cc5df0f59d79e31cce84e3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae403e54b9cc5df0f59d79e31cce84e3f">&#9670;&nbsp;</a></span>SetClientString()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetClientString </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>clientPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a>&#160;</td>
          <td class="paramname"><em>valuePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a9f7dcc184f901c713274edfdac5bcc9a">XMP_StringLen</a>&#160;</td>
          <td class="paramname"><em>valueLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="afd30a5ad1765a9288e7f6ef118255a73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd30a5ad1765a9288e7f6ef118255a73">&#9670;&nbsp;</a></span>SetClientStringVector()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetClientStringVector </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>clientPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#ad439e3ceeb4590d310f6125aa12c6df6">XMP_StringPtr</a> *&#160;</td>
          <td class="paramname"><em>arrayPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XMP_Uns32&#160;</td>
          <td class="paramname"><em>stringCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="accc6c1cef9f124f6c5ed360251aa5aa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accc6c1cef9f124f6c5ed360251aa5aa7">&#9670;&nbsp;</a></span>SetDefaultErrorCallback()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetDefaultErrorCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a32284d1645c6d852761b107b0232c285">XMPFiles_ErrorCallbackProc</a>&#160;</td>
          <td class="paramname"><em>proc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>context</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XMP_Uns32&#160;</td>
          <td class="paramname"><em>limit</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#accc6c1cef9f124f6c5ed360251aa5aa7" title="SetDefaultErrorCallback() registers a global default error notification callback.">SetDefaultErrorCallback()</a> registers a global default error notification callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">proc</td><td>The client's callback function.</td></tr>
    <tr><td class="paramname">context</td><td>Client-provided context for the callback.</td></tr>
    <tr><td class="paramname">limit</td><td>A limit on the number of notifications to be delivered. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a83335ee20bb3ea543c8c86a5757a7753"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83335ee20bb3ea543c8c86a5757a7753">&#9670;&nbsp;</a></span>SetDefaultProgressCallback()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetDefaultProgressCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a9639ef73ab21086098b0f099de248f26">XMP_ProgressReportProc</a>&#160;</td>
          <td class="paramname"><em>proc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>context</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>interval</em> = <code>1.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>sendStartStop</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#a83335ee20bb3ea543c8c86a5757a7753" title="SetDefaultProgressCallback() sets a global default for progress tracking. This is used as a default f...">SetDefaultProgressCallback()</a></code> sets a global default for progress tracking. This is used as a default for XMPFiles (library) objects created after the default is set. This does not affect the callback for new SXMPFiles (client) objects with an existing XMPFiles object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">proc</td><td>The client's callback function. Can be zero to disable notifications.</td></tr>
    <tr><td class="paramname">context</td><td>A pointer used to carry client-private context.</td></tr>
    <tr><td class="paramname">interval</td><td>The desired number of seconds between notifications. Ideally the first notification is sent after this interval, then at each following multiple of this interval.</td></tr>
    <tr><td class="paramname">sendStartStop</td><td>A Boolean value indicating if initial and final notifications are wanted in addition to those at the reporting intervals. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a43a98633a0090fb4ade76edf24302ab1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43a98633a0090fb4ade76edf24302ab1">&#9670;&nbsp;</a></span>SetErrorCallback()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetErrorCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a32284d1645c6d852761b107b0232c285">XMPFiles_ErrorCallbackProc</a>&#160;</td>
          <td class="paramname"><em>proc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>context</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XMP_Uns32&#160;</td>
          <td class="paramname"><em>limit</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classTXMPFiles.html#a43a98633a0090fb4ade76edf24302ab1" title="SetErrorCallback() registers an error notification callback.">SetErrorCallback()</a> registers an error notification callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">proc</td><td>The client's callback function.</td></tr>
    <tr><td class="paramname">context</td><td>Client-provided context for the callback.</td></tr>
    <tr><td class="paramname">limit</td><td>A limit on the number of notifications to be delivered. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa283e2a1c16918c86148446859ed1a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa283e2a1c16918c86148446859ed1a2d">&#9670;&nbsp;</a></span>SetProgressCallback()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::SetProgressCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="XMP__Const_8h.html#a9639ef73ab21086098b0f099de248f26">XMP_ProgressReportProc</a>&#160;</td>
          <td class="paramname"><em>proc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>context</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>interval</em> = <code>1.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>sendStartStop</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="classTXMPFiles.html#aa283e2a1c16918c86148446859ed1a2d" title="SetProgressCallback() sets the progress notification callback for the associated XMPFiles (library) o...">SetProgressCallback()</a></code> sets the progress notification callback for the associated XMPFiles (library) object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">proc</td><td>The client's callback function. Can be zero to disable notifications.</td></tr>
    <tr><td class="paramname">context</td><td>A pointer used to carry client-private context.</td></tr>
    <tr><td class="paramname">interval</td><td>The desired number of seconds between notifications. Ideally the first notification is sent after this interval, then at each following multiple of this interval.</td></tr>
    <tr><td class="paramname">sendStartStop</td><td>A Boolean value indicating if initial and final notifications are wanted in addition to those at the reporting intervals. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a1e8de80c252b60b332dc4bc524139fd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e8de80c252b60b332dc4bc524139fd8">&#9670;&nbsp;</a></span>Terminate()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::Terminate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Terminates use of the XMPFiles library. </p>
<p>Optional. Deallocates global data structures created by intialization. Its main action is to deallocate heap-allocated global storage, for the benefit of client leak checkers.</p>
<p>This function is static; make the call directly from the concrete class (<code>SXMPFiles</code>). </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5977d8094086a7c2bfa9abe03af2265c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5977d8094086a7c2bfa9abe03af2265c">&#9670;&nbsp;</a></span>xmpFilesRef</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class tStringObj &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="XMP__Const_8h.html#aa4bca98ad67d7a62c60cb13dbbab0f25">XMPFilesRef</a> <a class="el" href="classTXMPFiles.html">TXMPFiles</a>&lt; tStringObj &gt;::xmpFilesRef</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="TXMPFiles_8hpp_source.html#l00844">844</a> of file <a class="el" href="TXMPFiles_8hpp_source.html">TXMPFiles.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>public/include/<a class="el" href="TXMPFiles_8hpp_source.html">TXMPFiles.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classTXMPFiles.html">TXMPFiles</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
